PBDTOpenInform

PBDTOpenInform
Header:	Files.h		Carbon status:	Supported

Gets the reference number of the specified desktop database, reporting whether the desktop database was empty when it was opened. This function runs synchronously only.

OSErr PBDTOpenInform (
    DTPBPtr paramBlock
);

paramBlock: A pointer to a desktop parameter block.

function result: A result code.

DISCUSSION

Clear all fields (other than input fields) in the parameter block that you pass to Desktop Manager functions. The relevant fields of the parameter block for this function are:

ioResultOn return, the result code of the function. A value of type OSErr.
ioNamePtrOn input, a pointer to the volume name or full pathname of the desktop database. A value of type StringPtr.
ioVRefName On input, the volume reference number of the desktop database. A value of type SInt16.
ioDTRefNumOn return, the desktop database reference number, which represents the access path to the database. A value of type SInt16. You cannot use the desktop reference number as a file reference number in any File Manager functions. If PBDTOpenInform fails, it sets this field to 0.
ioTagInfoOn return, the return flag (in low bit). If the desktop database was just created in response to PBDTOpenInform (and is therefore empty), PBDTOpenInform sets the low bit in the ioTagInfo field to 0. If the desktop database had been created before you called PBDTOpenInform, PBDTOpenInform sets the low bit in the ioTagInfo field to 1. A value of type SInt32.

SPECIAL CONSIDERATIONS

All of the Desktop Manager functions may move or purge memory blocks in the application heap or for some other reason should not be called from within an interrupt. Your application should not call Desktop Manager functions at interrupt time.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.